CIMPLICITY Configuration REST API Web Service
CIMPLICITY Configuration REST API Web Service / All Operations Resource Group / /projects/{projectId}/securityGroups (Get)
In This Topic
    Get/projects/{projectId}/securityGroups
    In This Topic
    Description
    returns a list of securitygroups in a project that satisfy the filter criteria
    Parameters
    NameDescriptionData Type
    the id of the project to look instring
    number of records to skip for paginationinteger (int32)
    maximum number of records to returninteger (int32)
    provides a wild card string to filter securitygroups by their SecurityGroupName.string
    a wild card string to filter the securitygroups list by description.string
    provides a wild card string to filter securitygroups using their corresponding RoleID.string
    Rank of the securitygroup to filter corresponding Rankinteger (int32)
    200 Response

    The response body is of type SecurityGroupsGetResponse.

    The collection of securitygroups that satisfy the query.

    Overview

    SecurityGroupsGetResponse
    The results of the securityGroups get query.
    SecurityGroups : Array[CimSecurityGroup]
    SecurityGroupName : string
    Description : string
    Rank : integer
    Resources : Array[string]
    RoleID : string
    Fault Responses
    FaultDescription
    This fault returns a response body of type ProblemDetails.
    project with the given id is not registered on the system
    See Also